com.rnett.action.core

AnnotationProperties

data class AnnotationProperties

Properties for GitHub actions state annotations.

core

object core

Wrappers for @actions/core.

env

object env : Environment

Environment accessors, where set variables are not exported (i.e.

Environment

abstract class Environment(defaultExport: Boolean) : MutableDelegatable, ReadWriteProperty<Any?, String?>

Environment variable accessors, that by default exports if defaultExport is true.

exportEnv

object exportEnv : Environment

Environment accessors, where set variables are exported for other steps and tasks.

inputs

object inputs : Delegatable, ReadOnlyProperty<Any?, String>

Accessors for input variables.

logger

object logger

Methods to log to the GitHub action log.

outputs

object outputs : ReadWriteProperty<Any?, String>

A setter to set outputs.

PATH

object PATH

A setter for the path.

state

object state : MutableDelegatable, ReadWriteProperty<Any?, String>

Accessors for state.

fail

fun fail(message: String): Nothing

Fail with message, logging message as an error and killing the process.

fun fail(exception: Throwable): Nothing

Fail with exception, logging exception as an error and killing the process.

maskSecret

fun String.maskSecret()

Mask this in log output.

fun maskSecret(secret: String)

Mask secret in log output.

runAction

inline fun runAction(flush: Boolean = true, block: () -> Unit)

Runs block, failing the action if exceptions are thrown

runOrFail

inline fun <R> runOrFail(finally: () -> Unit = {}, flush: Boolean = true, block: () -> R): R

Runs block, fail-ing if an exception is thrown and not caught within block.

runOrLogException

inline fun <R> runOrLogException(finally: () -> Unit = {}, flush: Boolean = true, block: () -> R): Result<R>

Runs block, logging (as logger.error) any exceptions that are not caught within block.

isActionRunner

val isActionRunner: Boolean

true if the current environment is a GitHub actions runner.

Package com.rnett.action.core

Types

Functions

Properties